chore: integrate storageService with tokenListController #7413
+1,588
−95
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sahar-fehri
commented
Dec 9, 2025
| tokensChainsCache: { | ||
| includeInStateLogs: false, | ||
| persist: true, | ||
| persist: false, // Persisted separately via StorageService |
Contributor
Author
There was a problem hiding this comment.
Making this false to block disk writes
7 tasks
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
…oading and saving
Prithpal-Sooriya
previously approved these changes
Dec 16, 2025
salimtb
previously approved these changes
Dec 16, 2025
…tchTokenList calls
| this.#persistDebounceTimer = undefined; | ||
| } | ||
| this.#changedChainsToPersist.clear(); | ||
| this.#chainsLoadedFromStorage.clear(); |
There was a problem hiding this comment.
Pending state changes lost when controller is destroyed
Medium Severity
The destroy() method cancels the debounce timer and clears #changedChainsToPersist without flushing pending changes to storage. If the controller is destroyed within 500ms of a token fetch or state update, the updated token cache data will be discarded and never persisted. On next app launch, stale data would be loaded from storage instead of the fresher data that was fetched but not persisted.
Prithpal-Sooriya
previously approved these changes
Jan 20, 2026
Contributor
Author
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
Prithpal-Sooriya
approved these changes
Jan 26, 2026
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
sahar-fehri
deleted the
chore/integrate-storage-service-with-tokenListController
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Optimizes TokenListController storage to reduce write amplification by persisting tokensChainsCache via StorageService using per-chain files instead of a single monolithic state property.
Mobile: MetaMask/metamask-mobile#24019
Extension: MetaMask/metamask-extension#39250
Related: https://github.com/MetaMask/metamask-mobile/pull/22943/files
Related: https://github.com/MetaMask/decisions/pull/110
Related: #7192
Explanation
The tokensChainsCache (~5MB total, containing token lists for all chains) was persisted as part of the controller state. Every time a single chain's token list was updated (~100-500KB), the entire ~5MB cache was rewritten to disk, causing:
Solution
Per-Chain File Storage:
Each chain's cache is now stored in a separate file (e.g., tokensChainsCache:0x1, tokensChainsCache:0x89)
Only the updated chain (~100-500KB) is written on each token fetch, reducing write operations by ~90-95%
All chains are loaded in parallel at startup to maintain compatibility with TokenDetectionController
Key Changes:
References
Checklist
Note
Moves
TokenListControllertoken cache to per-chain persistence viaStorageService, reducing write amplification and decoupling it from controller state.tokensChainsCacheis no longer state-persisted (persist: false); clients must callawait controller.initialize()after constructiontokensChainsCache:<chainId>), parallel load on init, debounced persistence of changed chains only, and robust error handlingclearingTokenListData()is async and removes per-chain files; state updated accordingly@metamask/storage-servicedependency and tsconfig references; updates changelogWritten by Cursor Bugbot for commit 3da918d. This will update automatically on new commits. Configure here.